-
-
Notifications
You must be signed in to change notification settings - Fork 23
v3.0.0a1: Bump IDOM to 1.0.0 pre-release #125
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@rmorshea Can you pull down this branch and check out the new docs styling with I went pretty deep into making it feel React-like. |
|
Overall, I think the docs look great. I'm excited to have the core docs done in this style. The only criticism I have at the moment is that there may be some over reliance on admonitions. I don't have any alternate suggestions at the moment, but this is a thought I had when looking at this particular case: |
I'm realizing I completely forgot to checkout this branch when I checked out the docs. The similarity to React's docs is uncanny! In some ways I prefer the mkdocs styling. I always found this part of the sidebar in the beta docs to be busy and distracting for some reason: and since mkdocs doesn't have that the left sidebar is much more readable. |
I considered replicating the react docs sidebar while doing this styling. But ultimately agreed with you that I think mkdocs layout is better. Additionally if we did that, we'd be changing the mkdocs jinja templates, which is more prone to catastrophically breaking under future updates of mkdocs. |
I left |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I say we get this in so it's easier to install and test out. Since it's a pre-release it shouldn't be a huge problem if its buggy.
Description
idom.html
APIidom>=1.0.0
requirements.txt
be fully inclusive of all dev/user/docs dependencies to simplify development workflowsetup.py
to automatically install the latest NPM, and be easier to debug when things failChecklist:
Please update this checklist as you complete each item: